/**
 * This file is part of Adaptools.
 * 
 * Adaptools is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Adaptools is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 * along with Adaptools.  If not, see http://www.gnu.org/licenses/. 
 */
package org.adaptools.filecontroler;

import org.adaptools.base.exception.AdaptoolsException;
import org.adaptools.filecontroler.impl.AdaptoolsFileType;
import org.adaptools.repository.base.Repository;

/**
 * Interface to FileControler
 * 
 * @author Denys G. Santos (gsdenys@gmail.com)
 * @since 3.0.0
 */
public interface AdaptoolsFileController {
		
	/**
	 * Method to init File Controler
	 * 
	 * @param repository
	 * @param mechanismUUID
	 */
	public void init(Repository repository, String mechanismUUID);
	
	/**
	 * Save file in actual place
	 * 
	 * @param filePath
	 * 
	 * @return boolean
	 */
	public void save(String filePath) throws AdaptoolsException;
	
	
	/**
	 * Save File as
	 * 
	 * @param type - Type of file to be load
	 * @param filePath - file path to be save
	 * 
	 * @return boolean
	 */
	public void saveAs(AdaptoolsFileType type, String filePath) throws AdaptoolsException;
	
	
	/**
	 * Load file and put its content in the adequate place. 
	 * 
	 * @param filePath - the path of File
	 * 
	 * @return boolean
	 */
	public void load(String filePath) throws AdaptoolsException; 
	
	
	/**
	 * Load string putting it in the adequate place.
	 * 
	 * @param type - type of file to be save
	 * @param content - content to be load
	 * 
	 * @return boolean
	 */
	public void load(AdaptoolsFileType type, String filePath) throws AdaptoolsException;
	
}
